عملیات Shutil پایتون: تسلط بر کپی، انتقال و مدیریت آرشیو فایل

ماژول shutil پایتون یک رابط سطح بالا برای عملیات فایل فراهم می کند و توابع مناسبی را برای کارهایی مانند کپی، انتقال، بایگانی و حذف فایل ها و دایرکتوری ها ارائه می دهد. این امر آن را به ابزاری ارزشمند برای توسعه دهندگانی تبدیل می کند که روی پروژه های مختلف، از اسکریپت های ساده گرفته تا گردش کار اتوماسیون پیچیده، کار می کنند. این راهنما به بررسی عملکردهای اصلی shutil می پردازد و توضیحات واضح و مثال های عملی مناسب برای توسعه دهندگان در سراسر جهان ارائه می دهد.

شروع کار با Shutil

قبل از شروع، مطمئن شوید که پایتون را نصب کرده اید. ماژول shutil بخشی از کتابخانه استاندارد پایتون است، بنابراین نیازی به نصب اضافی نیست. می توانید آن را با استفاده از دستور زیر وارد کنید:

            import shutil
            

              
                Copy
              
            
          

کپی فایل ها و دایرکتوری ها

کپی فایل ها با shutil.copy() و shutil.copy2()

تابع shutil.copy(src, dst) فایل را از منبع (src) به مقصد (dst) کپی می کند. اگر dst یک دایرکتوری باشد، فایل با همان نام فایل پایه در آن دایرکتوری کپی می شود. این تابع مجوزهای فایل را حفظ می کند اما ابرداده هایی مانند زمان اصلاح، زمان دسترسی و سایر ویژگی ها را حفظ نمی کند.

            import shutil

# Example: Copy a file
src_file = 'source_file.txt'
dst_file = 'destination_file.txt'
shutil.copy(src_file, dst_file)
print(f'File \'{src_file}\' copied to \'{dst_file}\'')

            

              
                Copy
              
            
          

تابع shutil.copy2(src, dst) برخلاف shutil.copy()، ابرداده های فایل (مانند زمان اصلاح، زمان دسترسی و سایر ویژگی ها) را علاوه بر مجوزهای فایل حفظ می کند. این امر به ویژه هنگامی مفید است که نیاز به حفظ ویژگی های فایل اصلی در طول عملیات کپی دارید.

            import shutil
import os

# Example: Copy a file and preserve metadata
src_file = 'source_file.txt'
dst_file = 'destination_file.txt'

# Create a source file to demonstrate the metadata preservation
with open(src_file, 'w') as f:
    f.write('This is a test file.')

original_mtime = os.path.getmtime(src_file)

shutil.copy2(src_file, dst_file)

new_mtime = os.path.getmtime(dst_file)

print(f'Original modification time: {original_mtime}')
print(f'New modification time: {new_mtime}')
print(f'File \'{src_file}\' copied to \'{dst_file}\' with metadata preserved.')

            

              
                Copy
              
            
          

کپی درخت های دایرکتوری با shutil.copytree()

تابع shutil.copytree(src, dst) به صورت بازگشتی کل درخت دایرکتوری را از منبع (src) به مقصد (dst) کپی می کند. اگر دایرکتوری مقصد وجود نداشته باشد، ایجاد می شود. اگر وجود داشته باشد، مگر اینکه پارامتر dirs_exist_ok را روی True تنظیم کنید، خطایی رخ می دهد.

            import shutil
import os

# Example: Copy a directory tree
src_dir = 'source_directory'
dst_dir = 'destination_directory'

# Create a source directory and some files to copy
os.makedirs(src_dir, exist_ok=True)
with open(os.path.join(src_dir, 'file1.txt'), 'w') as f:
    f.write('Content of file1')
with open(os.path.join(src_dir, 'file2.txt'), 'w') as f:
    f.write('Content of file2')

shutil.copytree(src_dir, dst_dir, dirs_exist_ok=True) # dirs_exist_ok=True to overwrite if it exists.
print(f'Directory \'{src_dir}\' copied to \'{dst_dir}\'')

            

              
                Copy
              
            
          

ملاحظات مهم برای کپی دایرکتوری ها:

• مقصد نباید وجود داشته باشد: به طور پیش فرض، اگر دایرکتوری مقصد از قبل وجود داشته باشد، shutil.copytree() یک OSError را افزایش می دهد. از dirs_exist_ok=True استفاده کنید تا از این امر جلوگیری کرده و محتوای موجود را بازنویسی کنید.
• مجوزها: copytree تلاش می کند تا مجوزها و سایر ابرداده ها را تا حد امکان حفظ کند، اما این می تواند به سیستم فایل زیربنایی بستگی داشته باشد.
• مدیریت خطا: توصیه می شود که shutil.copytree() را در یک بلوک try...except قرار دهید تا خطاهای احتمالی مانند مجوزهای ناکافی یا مشکلات سیستم فایل را مدیریت کنید.

انتقال فایل ها و دایرکتوری ها

انتقال فایل ها با shutil.move()

تابع shutil.move(src, dst) یک فایل یا دایرکتوری را از منبع (src) به مقصد (dst) منتقل می کند. اگر dst یک دایرکتوری باشد، منبع با همان نام فایل پایه به آن دایرکتوری منتقل می شود. اگر dst یک فایل باشد، منبع به dst تغییر نام داده و فایل اصلی را بازنویسی می کند. از این تابع می توان برای تغییر نام فایل ها در همان دایرکتوری نیز استفاده کرد.

            import shutil
import os

# Example: Move a file
src_file = 'source_file.txt'
dst_file = 'destination_directory/moved_file.txt'

# Create a dummy source file
with open(src_file, 'w') as f:
    f.write('This is a test file.')

# Create destination directory if it doesn't exist
os.makedirs('destination_directory', exist_ok=True)

shutil.move(src_file, dst_file)
print(f'File \'{src_file}\' moved to \'{dst_file}\'')

            

              
                Copy
              
            
          

ملاحظات مهم برای انتقال فایل ها:

• بازنویسی: اگر فایل مقصد از قبل وجود داشته باشد، بازنویسی می شود.
• تغییر نام: می توانید از shutil.move() برای تغییر نام یک فایل در همان دایرکتوری با ارائه یک نام فایل متفاوت به عنوان مقصد استفاده کنید.
• انتقال بین سیستم های فایل: انتقال بین سیستم های فایل مختلف می تواند زمان بر باشد زیرا شامل کپی داده ها و سپس حذف نسخه اصلی است.
• مدیریت خطا: مشابه کپی کردن، مهم است که خطاهای احتمالی مانند مشکلات مجوز یا مشکلات سیستم فایل را با یک بلوک try...except مدیریت کنید.

انتقال دایرکتوری ها

shutil.move() همچنین می تواند کل دایرکتوری ها را منتقل کند. رفتار مشابه انتقال فایل ها است: اگر مقصد یک دایرکتوری موجود باشد، دایرکتوری منبع به آن منتقل می شود. اگر مقصد یک مسیر غیر موجود باشد، نام دایرکتوری منبع به گونه ای تغییر می کند که با نام مقصد مطابقت داشته باشد. عملیات انتقال تلاش می کند تا حد امکان ویژگی های فایل را حفظ کند، اما سطح حفظ به سیستم عامل زیربنایی بستگی دارد.

            import shutil
import os

# Example: Move a directory
src_dir = 'source_directory'
dst_dir = 'destination_directory'

# Create a source directory and some files to copy
os.makedirs(src_dir, exist_ok=True)
with open(os.path.join(src_dir, 'file1.txt'), 'w') as f:
    f.write('Content of file1')

#Create destination directory if it doesn't exist
os.makedirs('destination_directory', exist_ok=True)

shutil.move(src_dir, dst_dir)
print(f'Directory \'{src_dir}\' moved to \'{dst_dir}\'')

            

              
                Copy
              
            
          

حذف فایل ها و دایرکتوری ها

حذف فایل ها با os.remove() و os.unlink()

ماژول shutil عملکردهای حذف فایل را ارائه *نمی کند*. با این حال، می توانید از تابع os.remove(path) یا os.unlink(path) از ماژول داخلی os برای حذف یک فایل استفاده کنید. این توابع از نظر عملکرد یکسان هستند.

            import os

# Example: Delete a file
file_to_delete = 'file_to_delete.txt'

# Create a dummy file to delete
with open(file_to_delete, 'w') as f:
    f.write('This file will be deleted.')

os.remove(file_to_delete)
print(f'File \'{file_to_delete}\' deleted.')

            

              
                Copy
              
            
          

حذف دایرکتوری ها با shutil.rmtree()

تابع shutil.rmtree(path) به صورت بازگشتی یک درخت دایرکتوری را حذف می کند. این تابع بسیار قدرتمند (و به طور بالقوه خطرناک) است زیرا تمام فایل ها و زیر شاخه ها را در دایرکتوری مشخص شده، از جمله خود دایرکتوری، حذف می کند. استفاده از آن با احتیاط و بررسی مجدد مسیر برای جلوگیری از حذف تصادفی داده های مهم بسیار مهم است. این تابع معادل دستور 'rm -rf' در سیستم های شبه یونیکس است.

            import shutil
import os

# Example: Delete a directory tree
dir_to_delete = 'directory_to_delete'

# Create a directory and some files to delete
os.makedirs(dir_to_delete, exist_ok=True)
with open(os.path.join(dir_to_delete, 'file1.txt'), 'w') as f:
    f.write('Content of file1')

shutil.rmtree(dir_to_delete)
print(f'Directory \'{dir_to_delete}\' and its contents deleted.')

            

              
                Copy
              
            
          

ملاحظات مهم برای حذف دایرکتوری ها:

• غیر قابل برگشت: فایل ها و دایرکتوری های حذف شده عموماً *قابل بازیابی نیستند* (بدون تکنیک های پیشرفته بازیابی اطلاعات).
• مجوزها: اطمینان حاصل کنید که مجوزهای لازم برای حذف دایرکتوری و محتویات آن را دارید.
• مدیریت خطا: از یک بلوک try...except برای گرفتن استثنائاتی مانند OSError (به عنوان مثال، رد شدن مجوز) استفاده کنید.
• مسیر را دوباره بررسی کنید: همیشه قبل از فراخوانی shutil.rmtree() مسیر را تأیید کنید تا از از دست دادن تصادفی داده ها جلوگیری کنید. استفاده از یک متغیر برای ذخیره مسیر را در نظر بگیرید تا تأیید آن آسان تر شود.

بایگانی و از بایگانی خارج کردن فایل ها

ایجاد آرشیو با shutil.make_archive()

تابع shutil.make_archive(base_name, format, root_dir, base_dir, owner, group, logger) یک فایل آرشیو (به عنوان مثال، zip، tar یا سایر فرمت های پشتیبانی شده توسط ماژول های zipfile و tarfile) از یک دایرکتوری ایجاد می کند. چندین پارامتر را می پذیرد:

• base_name: نام فایل آرشیو (بدون پسوند).
• format: فرمت آرشیو (به عنوان مثال، 'zip', 'tar', 'gztar', 'bztar', 'xztar').
• root_dir: مسیر به دایرکتوری که می خواهید بایگانی کنید.
• base_dir (اختیاری): دایرکتوری که تمام فایل های موجود در root_dir نسبت به آن هستند. این به شما امکان می دهد فقط زیر مجموعه ای از root_dir را بایگانی کنید.
• owner (اختیاری): نام کاربری یا UID مالک برای آرشیو. فقط توسط فرمت های tar پشتیبانی می شود.
• group (اختیاری): نام گروه یا GID گروه برای آرشیو. فقط توسط فرمت های tar پشتیبانی می شود.
• logger (اختیاری): یک نمونه از یک شیء logger برای ثبت پیام ها.

            import shutil
import os

# Example: Create a zip archive
dir_to_archive = 'archive_this_directory'
archive_name = 'my_archive'
archive_format = 'zip'

# Create a directory and some files to archive
os.makedirs(dir_to_archive, exist_ok=True)
with open(os.path.join(dir_to_archive, 'file1.txt'), 'w') as f:
    f.write('Content of file1')
with open(os.path.join(dir_to_archive, 'file2.txt'), 'w') as f:
    f.write('Content of file2')

archive_path = shutil.make_archive(archive_name, archive_format, root_dir=dir_to_archive)
print(f'Archive created at: {archive_path}')

            

              
                Copy
              
            
          

استخراج آرشیوها با shutil.unpack_archive()

تابع shutil.unpack_archive(filename, extract_dir, format) یک آرشیو را در دایرکتوری مشخص شده استخراج می کند. از چندین فرمت آرشیو پشتیبانی می کند.

• filename: مسیر به فایل آرشیو.
• extract_dir: دایرکتوری که آرشیو در آن استخراج می شود.
• format (اختیاری): فرمت آرشیو. اگر مشخص نشده باشد، shutil تلاش می کند فرمت را از پسوند نام فایل استنباط کند.

            import shutil
import os

# Example: Extract a zip archive
archive_file = 'my_archive.zip'
extract_dir = 'extracted_directory'

# Create a zip archive first (as shown in the previous example if you dont have one.)
if not os.path.exists(archive_file):
    dir_to_archive = 'archive_this_directory'
    os.makedirs(dir_to_archive, exist_ok=True)
    with open(os.path.join(dir_to_archive, 'file1.txt'), 'w') as f:
        f.write('Content of file1')
    with open(os.path.join(dir_to_archive, 'file2.txt'), 'w') as f:
        f.write('Content of file2')
    archive_path = shutil.make_archive('my_archive', 'zip', root_dir=dir_to_archive)
    print(f'Archive created at: {archive_path}')

# Extract the archive
shutil.unpack_archive(archive_file, extract_dir)
print(f'Archive extracted to: {extract_dir}')

            

              
                Copy
              
            
          

تکنیک های پیشرفته و موارد استفاده

استفاده از shutil برای اتوماسیون

توابع موجود در shutil برای خودکارسازی وظایف مدیریت فایل و دایرکتوری عالی هستند. در اینجا چند مثال آورده شده است:

• اسکریپت های پشتیبان گیری: به طور منظم از فایل ها و دایرکتوری های مهم در مکان های مختلف پشتیبان تهیه کنید یا با استفاده از shutil.copytree() و shutil.make_archive() آنها را بایگانی کنید. این کار را می توان با استفاده از مشاغل cron در سیستم های شبه یونیکس یا Task Scheduler در ویندوز خودکار کرد. استراتژی هایی را برای پشتیبان گیری افزایشی برای کارایی پیاده سازی کنید.
• اسکریپت های استقرار: فایل های برنامه و وابستگی ها را با کپی کردن فایل ها و دایرکتوری های لازم در محیط هدف با استفاده از shutil.copytree() یا shutil.move() مستقر کنید. مدیریت جداگانه فایل های پیکربندی را در نظر بگیرید.
• خطوط لوله پردازش داده ها: داده ها را با انتقال، کپی و بایگانی فایل ها بر اساس معیارهای خاص با استفاده از این توابع سازماندهی و پردازش کنید. خطوط لوله مستند و قوی ایجاد کنید.
• سازماندهی و پاکسازی فایل ها: به طور منظم فایل های قدیمی را پاک کنید یا فایل ها را بر اساس نوع یا تاریخ اصلاح آنها با استفاده از os.remove()، shutil.move() و عبارات شرطی سازماندهی کنید.

مدیریت خطا و بهترین شیوه ها

مدیریت مؤثر خطا هنگام کار با عملیات فایل برای جلوگیری از مشکلات غیرمنتظره و از دست دادن داده ها بسیار مهم است. در اینجا برخی از بهترین شیوه ها آورده شده است:

• از بلوک های try...except استفاده کنید: تمام عملیات فایل (shutil.copy(), shutil.move(), shutil.copytree(), shutil.rmtree() و غیره) را در بلوک های try...except قرار دهید تا استثنائات احتمالی مانند OSError (برای خطاهای ورودی/خروجی فایل، مشکلات مجوز و غیره)، FileNotFoundError و PermissionError را دریافت کنید.
• ثبت خطاها: هنگام بروز استثناء، پیام خطا و سایر اطلاعات مربوطه (به عنوان مثال، مسیر فایل، عملیات در حال انجام) را در یک فایل گزارش ثبت کنید. این به شما کمک می کند تا بعداً مشکلات را عیب یابی کنید. از ماژول logging پایتون برای ورود به سیستم مناسب استفاده کنید.
• بررسی وجود فایل: قبل از انجام یک عملیات، بررسی کنید که آیا فایل یا دایرکتوری با استفاده از os.path.exists() یا os.path.isfile()/os.path.isdir() وجود دارد یا خیر تا از بروز خطاها جلوگیری شود.
• مدیریت مجوزها: اطمینان حاصل کنید که اسکریپت شما مجوزهای لازم برای انجام عملیات فایل را دارد. ممکن است لازم باشد اسکریپت را با امتیازات بالا اجرا کنید (به عنوان مثال، با استفاده از sudo در Linux/macOS یا اجرا به عنوان مدیر در ویندوز).
• تأیید مسیرها: همیشه مسیرهای فایل ها و دایرکتوری ها را دوباره بررسی کنید تا از از دست دادن تصادفی داده ها یا رفتار غیرمنتظره جلوگیری کنید. استفاده از مسیرهای مطلق را برای جلوگیری از سردرگمی در نظر بگیرید.
• اسکریپت های خود را به طور کامل آزمایش کنید: اسکریپت های عملیات فایل خود را در یک محیط امن قبل از استفاده از آنها در یک محیط تولید آزمایش کنید. از فایل ها و دایرکتوری های آزمایشی برای تأیید اینکه اسکریپت ها مطابق انتظار رفتار می کنند استفاده کنید.

مثال: ایجاد یک اسکریپت پشتیبان گیری ساده

در اینجا یک مثال اساسی از یک اسکریپت پشتیبان گیری آورده شده است. این یک نقطه شروع است. برای یک راه حل پشتیبان گیری واقعی، می خواهید مدیریت خطای قوی تر، ثبت و گزینه هایی برای پشتیبان گیری افزایشی و مکان های مختلف پشتیبان گیری اضافه کنید.

            import shutil
import os
import datetime

def backup_directory(source_dir, backup_dir):
    '''Backs up a directory to a backup location with a timestamp.'''
    try:
        # Create the backup directory with a timestamp
        timestamp = datetime.datetime.now().strftime('%Y%m%d_%H%M%S')
        backup_location = os.path.join(backup_dir, f'{os.path.basename(source_dir)}_{timestamp}')
        os.makedirs(backup_location, exist_ok=True)

        # Copy the directory tree
        shutil.copytree(source_dir, backup_location, dirs_exist_ok=True)
        print(f'Successfully backed up \'{source_dir}\' to \'{backup_location}\'')

    except OSError as e:
        print(f'Error during backup: {e}')

# Example usage:
source_directory = 'my_data'
backup_directory_location = 'backups'

#Create dummy data
os.makedirs(source_directory, exist_ok=True)
with open(os.path.join(source_directory, 'data.txt'), 'w') as f:
    f.write('Some important data.')

backup_directory(source_directory, backup_directory_location)

            

              
                Copy
              
            
          

مشکلات رایج و عیب یابی

در اینجا برخی از مشکلات رایجی که ممکن است با آن روبرو شوید و نحوه رفع آنها آورده شده است:

• خطاهای مجوز: اطمینان حاصل کنید که اسکریپت مجوزهای خواندن/نوشتن لازم را برای فایل ها و دایرکتوری هایی که روی آنها کار می کند دارد. مجوزهای فایل و دایرکتوری را با استفاده از ابزارهای سیستم عامل بررسی کنید.
• فایل یافت نشد: مسیر فایل و وجود فایل را تأیید کنید. قبل از انجام عملیات از os.path.exists() استفاده کنید.
• مشکلات فضای دیسک: اگر فایل‌های بزرگ را کپی یا بایگانی می‌کنید، مطمئن شوید که فضای دیسک کافی در درایو مقصد وجود دارد. فضای دیسک را با استفاده از os.statvfs() یا توابع مشابه بررسی کنید.
• مشکلات فرمت آرشیو: مطمئن شوید که فرمت آرشیوی که استفاده می‌کنید هم توسط سیستم منبع و هم سیستم مقصد پشتیبانی می‌شود. در صورت امکان، از یک فرمت پرکاربرد مانند ZIP استفاده کنید.
• مشکلات رمزگذاری کاراکتر: اگر با نام فایل هایی که حاوی کاراکترهای خاص یا کاراکترهایی خارج از محدوده ASCII هستند سروکار دارید، مطمئن شوید که رمزگذاری کاراکتر را به درستی مدیریت می کنید. از عملیات فایل آگاه از Unicode استفاده کنید.

نتیجه

ماژول shutil یک ابزار متنوع و قدرتمند برای مدیریت فایل ها و دایرکتوری ها در پایتون است. با درک عملکردهای اصلی آن - کپی، انتقال، بایگانی و حذف - و اعمال بهترین شیوه های مورد بحث در این راهنما، می توانید اسکریپت های مدیریت فایل کارآمد، قابل اعتماد و قوی بنویسید. به یاد داشته باشید که همیشه احتیاط کنید، به خصوص هنگام حذف فایل ها و دایرکتوری ها، و همیشه خطاها را به زیبایی مدیریت کنید تا از از دست دادن داده ها جلوگیری کنید و از ثبات برنامه های خود اطمینان حاصل کنید. این دانش در بسیاری از سناریوهای برنامه نویسی، از اسکریپت نویسی گرفته تا خودکارسازی گردش کار پیچیده در زمینه های مختلف بین المللی، ارزشمند خواهد بود.

با پیچیده تر شدن پروژه های شما، گنجاندن ویژگی های پیشرفته تر مانند گزارش، مدیریت خطا و اعتبارسنجی ورودی را برای ایجاد راه حل های آماده تولید که به راحتی با یک محیط جهانی سازگار هستند، در نظر بگیرید.